Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Improve README.md and CONTRIBUTING.md #22918

Merged

Conversation

steveburnett
Copy link
Contributor

@steveburnett steveburnett commented Jun 4, 2024

Description

Move

from CONTRIBUTING.md to README.md.

Add link from README.md to ARCHITECTURE.md.

Add separate link to installation doc to address part of the request in #22838.

Motivation and Context

Fixes #22838.

Impact

Documentation.

Test Plan

Pushed branch to my fork of the Presto repository, then used "View file" on the files in my branch to see the files as they will be displayed in Github. Also, CI.

Contributor checklist

  • Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== RELEASE NOTES ==

General Changes
* Improve README.md and CONTRIBUTING.md :pr:`22918`

Copy link
Contributor

@tdcmeehan tdcmeehan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @steveburnett

Copy link
Member

@jaystarshot jaystarshot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jaystarshot jaystarshot merged commit 09685c8 into prestodb:master Jun 5, 2024
56 checks passed
@steveburnett steveburnett deleted the steveburnett-README-CONTRIBUTING branch June 14, 2024 18:10
@wanglinsong wanglinsong mentioned this pull request Jun 25, 2024
36 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update home page Readme to include setup and general info/benchmarks about Presto
3 participants